CxGrpGrid Properties

The CxGrpGrid object contains the following properties:

Property	SubType	Read Only	Description
AllConfigXml	String	No	Gets/sets the grid default properties as an XML string. Note: This property is not intended to be used for typical scripts. It may be hidden in some property browsers.
AllowRowSizing	Boolean
AllowUnitsChange	Boolean		Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If 0 - No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.
AlternateUnits	Boolean		Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 - No and 1 - Yes. Default is 0 - No. Script subtype is Boolean.
AutoStart	Boolean	No	Specifies whether the control will automatically initiate Run mode when its container changes to Run mode. Options are 0 - No or 1 - Yes. The default is 1 - Yes. For the Group Grid Tool, AutoStart enables the Facility ID of each row to be automatically configured by a navigation bar. Set to 0 - No only when manually configuring the rows using script.
BackColor	OLE_COLOR	No	Returns/sets the color used for the grid areas not covered by headers or grid cells.
BorderStyle	Integer	No	Returns/sets the border style. 0 - no border. 1 - fixed single border.
CellBackColor	Long		Specifies the background color of a cell. Default is white (RGB 255.255.255). Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'
ColAlarmElement	Long	No	Gets/sets the alarm element for the specified column. See the Alarm Element As Long table for a list of possible values. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColConfigXml	String	No	Gets/sets the column properties as an XML string. Note: This property is not intended to be used for typical scripts. It may be hidden in some property browsers.
ColDisplayAlarmAck	Boolean	No	Enables/disables blinking when the point status is not acknowledged. True - enables blinking False - disables blinking Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColDisplayElement	Long	No	Gets/sets the display element for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColDisplayFormat	String	No	Gets/sets the display format for the specified column. The format string is a Microsoft Visual Basic format string. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColDisplayItem	Variant	No	Gets/sets the display item for the specified column. The display item can be set as a string or a number. Get returns an item number only. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColFacility	String	No	Gets/sets the Facility for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColLabelText	String	No	Gets/sets the label text for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColSiteService	String	No	Gets/sets the Site.Service for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColSortType	EColSortType	No	Gets/sets the Sort Type for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColTextAlign	ETextAlignment	No	Gets/sets the Text Alignment for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColTextOverflow	ETextOverflow	No	Returns/sets the Text Overflow option for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColTokenizedText	String	No	Gets/sets the Tokenized Text for a specified column.
ColUdc	String	No	Gets/sets the UDC for the specified column. Note: If you have a UserValue column you must save the user values before changing the UDC in order to keep the values. The change does not take effect until the grid is restarted. Call the Stop method, then set the column UDC, then call the Start method to restart the grid with the new configuration. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
Columns	Long	No	Gets/sets the number of columns in the grid. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ColUnknownTag	EUnknownTag	No	Gets/sets the Unknown Tag option for the specified column. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
ContextMenuXml	String		ContextMenuXml identifies an XML string that defines the contents and Event IDs for the object’s custom context menu.
CornerLabelText	String	No	Gets/sets the label text for the corner label.
EnableRowSelect	Boolean	No	Returns/sets the row select option state. True enables the row selection feature. False disables the feature.
EnableTrendMenu	Boolean		Enables the trending options on the right-click menu in Run mode. Default is 1 - Yes.
Facility	String	No	Returns/sets the default facility for the grid.
Font	StdFont	No	Returns/sets the font used by the grid.
KeepSelection	Boolean		Enables maintain cell selection when the sort order is changed. Default is 1 - Yes.
PageFooter	String		Specifies the text and text tokens for the report footer when printing the grid.
PageHeader	String		Specifies the text and text tokens for the report header when printing the grid.
RowConfigXml	String	No	Gets/sets the row properties as an XML string. Note: This property is not intended to be used for typical scripts. It may be hidden in some property browsers.
RowFacility	String	Yes	Gets/sets the Facility ID for the specified row. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
RowLabelText	String	Yes	Gets/sets the label text for the specified row. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
RowSiteService	String	No	Gets/sets the Site.Service for the specified row. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
RowUdc	String	No	Gets/sets the UDC for the specified row. Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.
SiteService	String	No	Returns/sets the default Site.Service for the grid.
StateColorMode	Long		[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 - Single), dual colors (2 - Dual), or not at all (0 - Off). The default is Single. Options include: Off (0 - eSTATECOLORMODE_OFF) Single Color (1 - eSTATECOLORMODE_SINGLE) Dual Colors (2 - eSTATECOLORMODE_DUAL) Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 - eOFF. Options include: 1 - eOFF 2 - eSINGLE_FOREGROUND 3 - eSINGLE_BACKGROUND 4 - eDUAL
UpdateInterval	Long	No	Returns/sets the cache refresh interval in milliseconds.
UseCustomStateColors	Boolean		[UseCustomStateColors] enables the use of the [CustomStateColors]. For TheView, this property enables use of TheView’s [CustomStateColors]. Default is 1 - Yes. For objects, this property enables use of the object’s [CustomStateColors]. Default is 1 - Yes. If this property is set to 0 - No for an object and is set to 1 - Yes for TheView, the object will use the custom state colors of TheView.

Property

SubType

Read Only

Description

AllConfigXml

String

Gets/sets the grid default properties as an XML string.

Note: This property is not intended to be used for typical scripts. It may be hidden in some property browsers.

AllowRowSizing

Boolean

AllowUnitsChange

Boolean

Enables unit changes to be displayed in Run mode. Unit types affected are primary and alternate. Options are 0 - No and 1 - Yes. The default is 1 - Yes. If 0 - No is specified, the Use Alternate Units option is disabled in Run mode. Script subtype is Boolean.

AlternateUnits

Boolean

Specifies that the object display values in alternate units instead of primary units. Alternate units must be defined in the point configuration record for the relevant point. Otherwise, alternate units cannot be displayed by the tool. Property sheet options are 0 - No and 1 - Yes. Default is 0 - No. Script subtype is Boolean.

AutoStart

Boolean

Specifies whether the control will automatically initiate Run mode when its container changes to Run mode. Options are 0 - No or 1 - Yes. The default is 1 - Yes.

For the Group Grid Tool, AutoStart enables the Facility ID of each row to be automatically configured by a navigation bar. Set to 0 - No only when manually configuring the rows using script.

BackColor

OLE_COLOR

Returns/sets the color used for the grid areas not covered by headers or grid cells.

BorderStyle

Integer

Returns/sets the border style.

0 - no border.

1 - fixed single border.

CellBackColor

Long

Specifies the background color of a cell. Default is white (RGB 255.255.255).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

ColAlarmElement

Long

Gets/sets the alarm element for the specified column. See the Alarm Element As Long table for a list of possible values.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColConfigXml

String

Gets/sets the column properties as an XML string.

Note: This property is not intended to be used for typical scripts. It may be hidden in some property browsers.

ColDisplayAlarmAck

Boolean

Enables/disables blinking when the point status is not acknowledged.

True - enables blinking

False - disables blinking

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColDisplayElement

Long

Gets/sets the display element for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColDisplayFormat

String

Gets/sets the display format for the specified column. The format string is a Microsoft Visual Basic format string.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColDisplayItem

Variant

Gets/sets the display item for the specified column. The display item can be set as a string or a number. Get returns an item number only.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColFacility

String

Gets/sets the Facility for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColLabelText

String

Gets/sets the label text for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColSiteService

String

Gets/sets the Site.Service for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColSortType

EColSortType

Gets/sets the Sort Type for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColTextAlign

ETextAlignment

Gets/sets the Text Alignment for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColTextOverflow

ETextOverflow

Returns/sets the Text Overflow option for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColTokenizedText

String

Gets/sets the Tokenized Text for a specified column.

ColUdc

String

Gets/sets the UDC for the specified column.

Note: If you have a UserValue column you must save the user values before changing the UDC in order to keep the values. The change does not take effect until the grid is restarted. Call the Stop method, then set the column UDC, then call the Start method to restart the grid with the new configuration.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

Columns

Long

Gets/sets the number of columns in the grid.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ColUnknownTag

EUnknownTag

Gets/sets the Unknown Tag option for the specified column.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

ContextMenuXml

String

ContextMenuXml identifies an XML string that defines the contents and Event IDs for the object’s custom context menu.

CornerLabelText

String

Gets/sets the label text for the corner label.

EnableRowSelect

Boolean

Returns/sets the row select option state.

True enables the row selection feature.

False disables the feature.

EnableTrendMenu

Boolean

Enables the trending options on the right-click menu in Run mode. Default is 1 - Yes.

Facility

String

Returns/sets the default facility for the grid.

Font

StdFont

Returns/sets the font used by the grid.

KeepSelection

Boolean

Enables maintain cell selection when the sort order is changed. Default is 1 - Yes.

PageFooter

String

Specifies the text and text tokens for the report footer when printing the grid.

PageHeader

String

Specifies the text and text tokens for the report header when printing the grid.

RowConfigXml

String

Gets/sets the row properties as an XML string.

Note: This property is not intended to be used for typical scripts. It may be hidden in some property browsers.

RowFacility

String

Yes

Gets/sets the Facility ID for the specified row.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

RowLabelText

String

Yes

Gets/sets the label text for the specified row.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

RowSiteService

String

Gets/sets the Site.Service for the specified row.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

RowUdc

String

Gets/sets the UDC for the specified row.

Note: If the grid is started, setting this property will not take effect until the grid is restarted. It is recommended that this property be set only when the grid is stopped.

SiteService

String

Returns/sets the default Site.Service for the grid.

StateColorMode

Long

[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 - Single), dual colors (2 - Dual), or not at all (0 - Off). The default is Single. Options include:

Off (0 - eSTATECOLORMODE_OFF)
Single Color (1 - eSTATECOLORMODE_SINGLE)
Dual Colors (2 - eSTATECOLORMODE_DUAL)

Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 - eOFF. Options include:

1 - eOFF
2 - eSINGLE_FOREGROUND
3 - eSINGLE_BACKGROUND
4 - eDUAL

UpdateInterval

Long

Returns/sets the cache refresh interval in milliseconds.

UseCustomStateColors

Boolean

[UseCustomStateColors] enables the use of the [CustomStateColors].

For TheView, this property enables use of TheView’s [CustomStateColors]. Default is 1 - Yes.
For objects, this property enables use of the object’s [CustomStateColors]. Default is 1 - Yes.

If this property is set to 0 - No for an object and is set to 1 - Yes for TheView, the object will use the custom state colors of TheView.